/***********************************************************************************************************************
*                                                                                                                      *
* SPLASH build system v0.1                                                                                             *
*                                                                                                                      *
* Copyright (c) 2013 Andrew D. Zonenberg                                                                               *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/

#include "splashcore.h"

using namespace std;

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Construction / destruction

SignedFirmwareNode::SignedFirmwareNode(
	BuildGraph* graph,
	CppExecutableNode* input,
	std::string password,
	std::string name)
	: BuildGraphNode(graph)
	, m_exe(input)
	, m_password(password)
	, m_name(name)
{
}

SignedFirmwareNode::~SignedFirmwareNode()
{
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Dependency scanning

string SignedFirmwareNode::GetHash()
{
	DebugPrintfHeading(4, "SignedFirmwareNode::GetHash() [node = \"%s\"]\n", m_name.c_str());
	string hashin = "";
	
	//Update our dependencies
	UpdateDependencies();
	
	//Add data at this node
	hashin += sha256(GetOutputPath());	//necessary to ensure static/shared/exe have different hashes
	hashin += sha256(m_password);
	
	//TODO: make this optional
	hashin += sha256("externdebug");
		
	//Add data for our dependencies
	for(size_t i=0; i<m_dependencies.size(); i++)
		hashin += m_dependencies[i]->GetHashCached();
	return sha256(hashin);
}

void SignedFirmwareNode::UpdateDependencies()
{
	DebugPrintfHeading(4, "SignedFirmwareNode::UpdateDependencies() [node = \"%s\"]\n", m_name.c_str());
	m_dependencies.clear();
	
	m_dependencies.push_back(m_exe);
	
	auto elfsign = m_graph->GetTargetForArch("elfsign", "x86_64-linux-gnu");
	if(!elfsign)
		FatalError("couldn't find elfsign");
	m_dependencies.push_back(elfsign);
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Compilation

string SignedFirmwareNode::GetOutputPath()
{
	return m_graph->GetOutDir() + "/" + m_exe->GetArchitecture() + "/" + m_name + "-signed";
}

string SignedFirmwareNode::GetDescription()
{
	char desc[1024];
	snprintf(desc, sizeof(desc), "Signed firmware image %s [%s]", m_name.c_str(), m_exe->GetArchitecture().c_str());
	return string(desc);
}

string SignedFirmwareNode::GetBinaryPath()
{
	return m_graph->GetMetaDir() + "/" + GetHashCached()  + "/" + m_name;
}

void SignedFirmwareNode::Update(Cluster* cluster)
{
	//Rebuild all of our dependencies if necessary
	vector<ClusterJob*> deps;
	for(size_t i=0; i<m_dependencies.size(); i++)
	{		
		BuildGraphNode* node = m_dependencies[i];
		node->UpdateCached(cluster);
		if(node->GetBuildJob() != NULL)
			deps.push_back(node->GetBuildJob());
	}
	
	//Get the input and output file names
	string infname = m_exe->GetBinaryPath();
	string outfname = GetBinaryPath();
	string path = GetDirOfFile(outfname);
	string base = GetBasenameOfFile(outfname);
	string basewe = GetBasenameOfFileWithoutExt(outfname);
	
	//Get the debug file name
	string debugfile = path + "/" + basewe + ".dbg";
	
	//Print the heading
	DebugPrintfHeading(3, "Signing executable file %s\n", base.c_str());

	auto elfsign = m_graph->GetTargetForArch("elfsign", "x86_64-linux-gnu");
	if(!elfsign)
		FatalError("couldn't find elfsign");

	//TODO: get binutils path from cpp toolchain
	char tmp[128];
	string objcopy;
	snprintf(tmp, sizeof(tmp), "%s-objcopy", m_exe->GetArchitecture().c_str());
	objcopy = tmp;
	string strip;
	snprintf(tmp, sizeof(tmp), "%s-strip", m_exe->GetArchitecture().c_str());
	strip = tmp;

	//Create the batch script
	string batch_fname = path + "/elfsign_batch_command_" + basewe + ".sh";
	FILE* fp = fopen(batch_fname.c_str(), "w");
	if(!fp)
		FatalError("Failed to create batch script %s\n", batch_fname.c_str());
	fprintf(fp, "#!/bin/bash\n");
	fprintf(fp, "cp %s %s\n", infname.c_str(), outfname.c_str());
	fprintf(fp, "%s --only-keep-debug %s %s || (touch build_failed; exit)\n",
		objcopy.c_str(), outfname.c_str(), debugfile.c_str() );
	fprintf(fp, "%s --strip-debug %s || (touch build_failed; exit)\n",
		strip.c_str(), outfname.c_str());
	fprintf(fp, "%s --add-gnu-debuglink=%s %s || (touch build_failed; exit)\n",
		objcopy.c_str(), debugfile.c_str(), outfname.c_str());
	fprintf(fp, "%s --password \"%s\" --sign %s > /dev/null || (touch build_failed; exit)\n",
		elfsign->GetOutputPath().c_str(),
		m_password.c_str(), outfname.c_str());
	fprintf(fp, "touch build_successful\n");
	fclose(fp);
	if(0 != chmod(batch_fname.c_str(), 0755))
		FatalError("Failed to set execute permissions on batch script %s\n", batch_fname.c_str());
		
	//Submit the batch script
	m_job = cluster->SubmitBatchJob(batch_fname, cluster->m_cppBuildPartition, path, deps);
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Factory method

SignedFirmwareNode* SignedFirmwareNode::CreateSignedFirmwareNode(
	BuildGraph* graph,
	CppExecutableNode* input,
	std::string password,
	std::string name,
	bool target)
{
	//Add the executable node
	SignedFirmwareNode* exenode = new SignedFirmwareNode(graph, input, password, name);
	graph->AddNodeWithPath(exenode, exenode->GetOutputPath(), input->GetArchitecture());
	
	//Add it as a top-level target if requested
	if(target)
		graph->AddTarget(exenode, input->GetTargetName());
	
	//Done
	return exenode;
}
